import { StaticHostDocIntro, StaticHostDocOutro, StaticHostDocStrategies } from '../../components/static-host'
import { RepoLink, Warning } from '@brillout/docpress'

<StaticHostDocIntro
  staticHostLink={<>, such as <a href="https://pages.github.com/">GitHub Pages</a></>}
/>

<StaticHostDocStrategies name="GitHub Pages" />

We recommend using the [GitHub Pages Deploy Action](https://github.com/JamesIves/github-pages-deploy-action). For example, `vike.dev` uses the GitHub action at <RepoLink path='.github/workflows/docs.yml' /> to automatically deploy whenever a commit changes the docs.

<StaticHostDocOutro
  baseUrlAddendum={<> You need to do this if you use the GitHub Page domain <code><i>username</i>.github.io/<i>repo-name/*</i></code>.</>}
/>

<Warning>
 Make to sure to add an empty file `.nojekyll`, otherwise [GitHub Pages won't serve static files starting with `_`](https://stackoverflow.com/questions/6397780/names-starting-with-underscore-shows-errors-page-doesnot-exists-for-gh-pages-bra).
</Warning>
